.TH E1432_SET_OCTAVE_INT_TIME 3 E1432
.SH NAME
.nf
e1432_set_octave_int_time \- Set Octave linear average integration time
e1432_get_octave_int_time \- Get Octave linear average integration time
.IX e1432_set_octave_int_time(3) 3
.IX e1432_get_octave_int_time(3) 3
.SH SYNOPSIS
.cS
SHORTSIZ16 e1432_set_octave_int_time(E1432ID hw, SHORTSIZ16 ID,
                                     FLOATSIZ32 octave_int_time)
SHORTSIZ16 e1432_get_octave_int_time(E1432ID hw, SHORTSIZ16 ID,
                                     FLOATSIZ32 *octave_int_time)
.cE
.SH DESCRIPTION

\fIe1432_set_octave_int_time\fR sets the average integration time
of the modules(s) selected
to the value given in \fIoctave_int_time\fR.

\fIe1432_get_octave_int_time\fR returns the average integration time
of the modules(s) selected
into a memory location pointed to by \fIoctave_int_time\fR.

This parameter is a "global" parameter.  It applies to an entire
module rather than to one of its channels.  The \fIID\fR parameter is
used only to identify which module the function applies to, and all
channels in that module will report the same value for this parameter.

\fIhw\fR must be the result of a successful call to
\fIe1432_assign_channel_numbers\fR, and specifies the group of
hardware to talk to.

\fIID\fR is either the ID of a group of channels that was obtained
with a call to \fIe1432_create_channel_group\fR, or the ID of a single
channel.
It is used to determine which module(s) in \fIhw\fR to set/query.

\fIoctave_int_time\fR must be within .001953125 seconds minimum
and 10,000 seconds maximum.
For values below 1 second, it is rounded to the nearest negative power of
two seconds.
For values above 1 second, it is rounded to the nearest second.
This parameter sets the average time for an Octave linear average.
For exponential averages, this parameter has no effect.

Because of internal fifo issues, larger values of \fIoctave_int_time\fR
will be rejected at the beginning of a measurement
with the \fBERR1432_ILLEGAL_OCTAVE_INT_TIME\fR error
if data other than E1432_ENABLE_TYPE_OCTAVE,
such as E1432_ENABLE_TYPE_TIME, is selected using
the e1432_set_enable function.
This limitation is also present in eavesdrop mode,
that is when time data is being thruput across the localbus
(see \fIe1432_set_data_port\fR).
The threshold value depends on the amount of DRAM installed,
the data_size selected,
as well as the number of channels enabled,
but generally falls in the range of .5 to a small number of seconds.
This problem can be aleviated by adjusting \fIoctave_time_step\fR
to cause average updates to occur below this threshold.
In general, it is best to not select data other than E1432_ENABLE_TYPE_OCTAVE
when using an \fIoctave_time_step\fR of any significant size.

.SH "RESET VALUE"
After a reset, \fIoctave_int_time\fR is set to 1.0 second.
.SH "RETURN VALUE"
Return 0 if successful, a (negative) error number otherwise.
.SH "SEE ALSO"
.na
e1432_set_octave_mode,
e1432_set_octave_avg_mode,
e1432_set_octave_hold_mode,
e1432_set_octave_start_freq, e1432_set_octave_stop_freq,
e1432_set_octave_time_const,
e1432_set_octave_time_step,
e1432_octave_ctl,
e1432_get_octave_blocksize,
e1432_get_current_data
.ad
